home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 6 / CU Amiga Magazine's Super CD-ROM 06 (1996)(EMAP Images)(GB)(Track 1 of 4)[!][issue 1997-01].iso / cucd / online / fidonetts / fsc-0056.001 < prev    next >
Text File  |  1991-07-21  |  54KB  |  1,065 lines
  1. Document: FSC-0056
  2. Version:  001
  3. Date:     03-May-1991
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                       EMSI/IEMSI Protocol Definitions
  10.                           Joaquim H. Homrighausen
  11.                                May 3, 1991
  12.  
  13.  
  14.  
  15.  
  16.     Status of this document:
  17.  
  18.      This FSC suggests a proposed protocol for the FidoNet(r) community,
  19.      and requests discussion and suggestions for improvements.
  20.      Distribution of this document is subject to the restrictions
  21.      specified on the next page.
  22.  
  23.      Fido and FidoNet are registered marks of Tom Jennings and Fido
  24.      Software.
  25.  
  26.  
  27.  
  28.  
  29.       (Also known as EMSC-001; Electronic Mail Standards Document #001)
  30.     ---------------------------------------------------------------------
  31.       Copyright 1989-1991 Joaquim H. Homrighausen. All rights reserved.
  32.     ---------------------------------------------------------------------
  33.  
  34.  
  35.     Notice
  36.     =====================================================================
  37.     This document obsoletes EMSI_003 and any previous document describing
  38.     the EMSI, UZAP, and/or IEMSI handshake protocol. I apologize for the
  39.     lack of proper state charts. I am currently under a fairly heavy
  40.     work-load and thought it would be better to release something half-
  41.     decent than not to release anything at all.
  42.  
  43.     Restrictions
  44.     =====================================================================
  45.     EMSI/IEMSI may be used by any developer as long as these
  46.     specifications are followed exactly. The IEMSI and EMSI specifications
  47.     may be implemented independently of each other.
  48.  
  49.     EMSI/IEMSI may be used free-of-charge by any developer for any
  50.     purpose, commercially or otherwise. In creating EMSI/IEMSI, we are
  51.     taking the first step towards developing a clear protocol definition
  52.     for state-of-the-art E-Mail systems to follow.
  53.  
  54.     This document and its NOTES file (EMSI.NOT) may be freely copied and
  55.     distributed, but must NEVER be distributed in a modified form. If you
  56.     have an enhancement request, please contact the author of this
  57.     document; do not change it yourself.
  58.  
  59.     Permission is hereby granted to the FTSC (Fidonet Technical Standards
  60.     Committee) and other technical organisations to republish this
  61.     document in its entirety. Librarians may change the title page and
  62.     page headers to match their library format as long as all copyrights
  63.     and body text remain unaltered. The original document name and source
  64.     (EMSC) must be mentioned in any republished versions of this
  65.     document.
  66.  
  67.     No organization, company, person, or other being may impose any fees
  68.     for any reason for providing this document. This document may not be
  69.     sold or otherwise transferred for personal or company gain under any
  70.     circumstances.
  71.  
  72.     Layout
  73.     =====================================================================
  74.     This document consists of four major parts; A short introduction and
  75.     explanation of the EMSI/IEMSI handshake protocol, the EMSI
  76.     definitions, the IEMSI definitions, and finally various notes and
  77.     credits.
  78.  
  79.  
  80.     PART I
  81.  
  82.     Introduction
  83.     =====================================================================
  84.     The EMSI/IEMSI handshake protocol allows for maximum flexibility in
  85.     E-Mail session start-up and control. The YooHoo (FTS-6) standard,
  86.     designed by Wynn Wagner III, was a good idea, but did not allow
  87.     sufficient room for growth and cannot be used in 7-bit environments.
  88.     EMSI/IEMSI should provide for virtually unlimited growth and
  89.     expansion of its own scope. By providing variable-length packets,
  90.     EMSI/IEMSI is capable of being as simple or as complex as necessary
  91.     and entirely backwards compatible when new features and/or protocols
  92.     are added.
  93.  
  94.     All EMSI/IEMSI packets and sequences consists of 7-bit printable
  95.     ASCII characters. This format allows us to establish a universal
  96.     handshake between "PCs" and "mainframes" alike. The more complicated
  97.     the computer system, the more restrictions affect its I/O; there are
  98.     many I/O channels that cannot transmit control characters such as XON
  99.     and XOFF; for this, we have created a universal handshake protocol
  100.     that uses all printable characters.
  101.  
  102.     EMSI/IEMSI does allow control and 8-bit ASCII characters to be
  103.     transmitted. This is, however, accomplished by escaping the data
  104.     and converting it to 7-bit printable ASCII characters.
  105.  
  106.     Data layer
  107.     =====================================================================
  108.     EMSI/IEMSI is a protocol based on multi-character sequences rather
  109.     than single character flow control. There are several advantages of
  110.     using several characters rather than just one, but there is also a
  111.     drawback. On very poor-quality telephone lines, EMSI will most likely
  112.     require several retransmissions of packets since line noise usually
  113.     come in bursts. That aside, there is little advantage in using a
  114.     protocol based on single characters.
  115.  
  116.     All EMSI/IEMSI sequences are terminated by a single <CR> unless
  117.     otherwise specified. This is necessary to force some data collection
  118.     equipment to flush their buffers. Appending <CR> to EMSI/IEMSI
  119.     sequences in a FidoNet environment is a delicate matter and it is
  120.     important that you follow the notes regarding this.
  121.  
  122.     Note regarding file requests
  123.     ---------------------------------------------------------------------
  124.     The file request concept mentioned in the EMSI document refers to
  125.     WaZOO style file requests as specified in FTS-6. No other file
  126.     request mechanism is supported in the EMSI specifications.
  127.  
  128.  
  129.     Separator usage
  130.     ---------------------------------------------------------------------
  131.     To designate the fields within the EMSI/IEMSI packets and retain
  132.     complete transparency, both start and stop characters are used.
  133.  
  134.     The ASCII1 type is used for all fields within the packet. This uses
  135.     the brace characters to delimit the fields. The '{' (ASCII 123)
  136.     character is the start byte and '}' (ASCII 125) is the stop byte.
  137.     If a stop byte is used as literal data within a field, it must be
  138.     transmitted twice. The end of a field is designated by a stop byte
  139.     that is not followed by another identical stop byte.
  140.  
  141.     The ASCII2 fields are delimited in exactly the same way, but use the
  142.     square brackets as delimiters. The '[' (ASCII 91) is the start byte
  143.     and ']' (ASCII 93) is the stop byte. ASCII2 is used to delimit data
  144.     within the ASCII1 extra_field information.
  145.  
  146.     7-bit data restriction
  147.     ---------------------------------------------------------------------
  148.     It is the developer's responsibility to ensure that the software
  149.     generates EMSI/IEMSI packets and sequences containing only 7-bit
  150.     (00H through 7eH) printable ASCII characters.
  151.  
  152.     It is recommended that all EMSI/IEMSI implementations strip the high-
  153.     order bit of all received characters prior to processing the packet/
  154.     sequence and prior to calculating CRC values.
  155.  
  156.     CRC values
  157.     ---------------------------------------------------------------------
  158.     The polynomial used to calculate a 16-bit CRC is the same polynomial
  159.     used in the Xmodem file transfer protocol. The polynomial used to
  160.     calculate a 32-bit CRC is the same polynomial used in the Zmodem file
  161.     transfer protocol.
  162.  
  163.     Binary values
  164.     ---------------------------------------------------------------------
  165.     Since the EMSI environment specifies only 7-bit printable ASCII
  166.     characters to be used, binary values, such as CRC and length
  167.     descriptors are expressed as a four character hexadecimal string. The
  168.     only exception to this is a 32-bit CRC value which is expressed as an
  169.     eight character hexadecimal string.
  170.  
  171.     The application must treat them case insensitive, eg. ffaa should be
  172.     treated identical to FFAA. 
  173.  
  174.  
  175.     Handling 8-bit data
  176.     ---------------------------------------------------------------------
  177.     Although EMSI only uses 7-bit printable ASCII characters, there is an
  178.     escape mechanism that allows systems to transmit control and 8-bit
  179.     ASCII characters without the requirement of an 8-bit data link. The
  180.     escape character is a backslash character ('\') and is followed by two
  181.     characters in hexadecimal notation. Eg. "\80" is the ASCII character
  182.     128. To insert an actual backslash character, two backslashes are used
  183.     ("\\"), or a backslash followed by the hexadecimal code for a
  184.     backslash, eg. "\5c".
  185.  
  186.     The hexadecimal code following a backslash MUST always be two
  187.     characters, ie. to insert ASCII 15 (hexadecimail 'f'), the result
  188.     would be "0f". All hexadecimal sequences must be treated case
  189.     insensitively.
  190.  
  191.  
  192.     PART II - Electronic Mail Standard Idenfitication
  193.  
  194.     Connecting two EMSI capable systems
  195.     =====================================================================
  196.     This assumes that the two systems are connected and that no data
  197.     has been transmitted by the Caller.
  198.  
  199.     It should be mentioned that sending/monitoring for the "YooHoo",
  200.     "TSYNC", and other protocol start characters is optional and not
  201.     required for a strict EMSI implementation.
  202.  
  203.     STEP 1, EMSI INIT    
  204.  
  205.         Calling system                   Answering system
  206.     +-+-------------------------------+----------------------------------+
  207.     :1: Send <CR> until ANY character : Send EMSI_REQ and possible       :
  208.     : : is received.                  : banner, etc.                     :
  209.     +-+-------------------------------+----------------------------------+
  210.     :2: Receive banner, etc. Monitor  : Monitor line for the EMSI_INQ    :
  211.     : : line for the EMSI_REQ         : sequence and if received,        :
  212.     : : sequence and if received,     : attempt to handshake immediately.:
  213.     : : transmit EMSI_INQ and attempt :                                  :
  214.     : : to handshake immediately.     :                                  :
  215.     +-+-------------------------------+----------------------------------+
  216.     :3: No EMSI_REQ sequence received,: Monitor line for EMSI_INQ and    :
  217.     : : send EMSI_INQ twice followed  : possible other protocol start    :
  218.     : : by possible other protocol    : characters and if received,      :
  219.     : : start characters.             : attempt to handshake immediately.:
  220.     : :                               :                                  :
  221.     : : Transmit <CR>                 : Go to step 3.                    :
  222.     +-+-------------------------------+----------------------------------+
  223.     :4: If EMSI_REQ sequence received,:
  224.     : : send EMSI_INQ and attempt to  :
  225.     : : handshake immediately,        :
  226.     : : otherwise repeat step 3.      :
  227.     +-+-------------------------------+
  228.  
  229.     In steps 1 and 2, both the Calling and Answering system terminate all
  230.     sequences with <CR>. In step 3, the Calling system does not terminate
  231.     sequences with <CR> as it is explicitly transmitted after possible
  232.     protocol start characters. In step 4, the Calling system once again
  233.     terminate all sequences with a <CR>.
  234.  
  235.  
  236.     STEP 2A, RECEIVE EMSI HANDSHAKE
  237.  
  238.     At this point, all sequences are terminated with a <CR>.
  239.  
  240.     +-+------------------------------------------------------------------+
  241.     :1: Tries=0, T1=20 seconds, T2=60 seconds                            :
  242.     +-+------------------------------------------------------------------+
  243.     :2: Increment Tries                                                  :
  244.     : :                                                                  :
  245.     : : Tries>6?                      Terminate, and report failure.     :
  246.     : +------------------------------------------------------------------+
  247.     : : Are we answering system?      Transmit EMSI_REQ, go to step 3.   :
  248.     : +------------------------------------------------------------------+
  249.     : : Tries>1?                      Transmit EMSI_NAK, go to step 3.   :
  250.     : +------------------------------------------------------------------+
  251.     : : Go to step 4.                                                    :
  252.     +-+------------------------------------------------------------------+
  253.     :3: T1=20 seconds                                                    :
  254.     +-+------------------------------------------------------------------+
  255.     :4: Wait for EMSI sequence until EMSI_HBT or EMSI_DAT or any of the  :
  256.     : : timers have expired.                                             :
  257.     : :                                                                  :
  258.     : : If T2 has expired, terminate call and report failure.            :
  259.     : +------------------------------------------------------------------+
  260.     : : If T1 has expired, go to step 2.                                 :
  261.     : +------------------------------------------------------------------+
  262.     : : If EMSI_HBT received, go to step 3.                              :
  263.     : +------------------------------------------------------------------+
  264.     : : If EMSI_DAT received, go to step 5.                              :
  265.     : +------------------------------------------------------------------+
  266.     : : Go to step 4.                                                    :
  267.     +-+------------------------------------------------------------------+
  268.     :5: Receive EMSI_DAT packet                                          :
  269.     : +------------------------------------------------------------------+
  270.     : : Packet received OK?                Transmit EMSI_ACK twice, and  :
  271.     : :                                    go to step 6.                 :
  272.     : +------------------------------------------------------------------+
  273.     : : Go to step 2.                                                    :
  274.     +-+------------------------------------------------------------------+
  275.     :6: Received EMSI_DAT packet OK, exit.                               :
  276.     +-+------------------------------------------------------------------+
  277.  
  278.     All processing of the information in the EMSI_DAT packet must be done
  279.     after transmitting EMSI_ACK twice to the remote system. It is
  280.     recommended that an EMSI_HBT sequence is issued once every seven
  281.     seconds while such processing is taking place to avoid unnecessary
  282.     handshake collissions. Emitting EMSI_HBT should only be done when
  283.     it is obvious that the remote system is waiting for the second phase
  284.     of the EMSI handshake to take place.
  285.  
  286.  
  287.  
  288.     STEP 2B, TRANSMIT EMSI HANDSHAKE
  289.  
  290.     At this point, all sequences are terminated with a <CR>.
  291.  
  292.     +-+------------------------------------------------------------------+
  293.     :1: Tries=0, T1=60 seconds                                           :
  294.     +-+------------------------------------------------------------------+
  295.     :2: Transmit EMSI_DAT packet and increment Tries                     :
  296.     : :                                                                  :
  297.     : +------------------------------------------------------------------+
  298.     : : Tries>6?                        Terminate, and report failure.   :
  299.     : +------------------------------------------------------------------+
  300.     : : Go to step 3.                                                    :
  301.     +-+------------------------------------------------------------------+
  302.     :3: T2=20 seconds                                                    :
  303.     +-+------------------------------------------------------------------+
  304.     :4: Wait for EMSI sequence until T1 has expired                      :
  305.     : :                                                                  :
  306.     : : If T1 has expired, terminate call and report failure.            :
  307.     : +------------------------------------------------------------------+
  308.     : : If T2 has expired, go to step 2.                                 :
  309.     : +------------------------------------------------------------------+
  310.     : : If EMSI_REQ received, go to step 4.                              :
  311.     : +------------------------------------------------------------------+
  312.     : : If EMSI_ACK received, go to step 5.                              :
  313.     : +------------------------------------------------------------------+
  314.     : : If any other sequence received, go to step 2.                    :             :
  315.     +-+------------------------------------------------------------------+
  316.     :5: Received EMSI_ACK, exit.                                         :
  317.     +-+------------------------------------------------------------------+
  318.  
  319.  
  320.     EMSI packet and sequence definitions
  321.     =====================================================================
  322.  
  323.     =====================================================================
  324.     EMSI Inquiry                                    **EMSI_INQ<crc16><CR>
  325.     ---------------------------------------------------------------------
  326.     EMSI Inquiry is transmitted by the calling system to identify it as
  327.     EMSI capable. If an EMSI_REQ sequence is received in response, it is
  328.     safe to assume the answering system to be EMSI capable.
  329.  
  330.     =====================================================================
  331.     EMSI Request                                    **EMSI_REQ<crc16><CR>
  332.     ---------------------------------------------------------------------
  333.     EMSI Request is transmitted by the answering system in response to an
  334.     EMSI Inquiry sequence. It should also be transmitted prior to or
  335.     immediately following the answering system has identified itself by
  336.     transmitting its program name and/or banner. If the calling system
  337.     receives an EMSI Request sequence, it can safely assume that the
  338.     answering system is EMSI capable.
  339.     
  340.     =====================================================================
  341.     EMSI Client                                     **EMSI_CLI<crc16><CR>
  342.     ---------------------------------------------------------------------
  343.     EMSI Client is used by terminal emulation software to force a mailer
  344.     front-end to bypass any unnecessary mail session negotiation and
  345.     treat the call as an incoming human caller. The EMSI_CLI sequence may
  346.     not be issued by any software attempting to establish a mail session
  347.     between two systems and must only be acted upon by an answering
  348.     system.
  349.  
  350.     =====================================================================
  351.     EMSI Heartbeat                                  **EMSI_HBT<crc16><CR>
  352.     ---------------------------------------------------------------------
  353.     EMSI Heartbeat is used to prevent unnecessary timeouts from occurring
  354.     while attempting to handshake. It is most commonly used when the
  355.     answering system turns around to transmit its EMSI_DAT packet. It is
  356.     quite normal that any of the timers of the calling system (which at
  357.     this stage is waiting for an EMSI_DAT packet) expires while the
  358.     answering system is processing the recently received EMSI_DAT packet.
  359.  
  360.     =====================================================================
  361.     EMSI Data                      **EMSI_DAT<len16><data_pkt><crc16><CR>
  362.     ---------------------------------------------------------------------
  363.     EMSI Data is transmitted by both the calling and answering system at
  364.     the appropriate time to exchange system information. Following the
  365.     header is a four byte number representing the length of <data_pkt>
  366.     excluding the CRC and terminating <CR>.
  367.  
  368.     The EMSI_DAT packet is a variable length packet. Since this is a
  369.     synchronous protocol, the inbound data buffer should be purged
  370.     between transmission of the <data_pkt> and <crc16> fields to prevent
  371.     accidental EMSI_NAK sequences, etc.
  372.  
  373.  
  374.     =====================================================================
  375.     EMSI ACK                                        **EMSI_ACK<crc16><CR>
  376.     ---------------------------------------------------------------------
  377.     EMSI ACK is transmitted by either system as a positive
  378.     acknowledgement of the valid receipt of a EMSI_DAT packet. This should
  379.     only be used as a response to EMSI_DAT and not any other packet.
  380.     Redundant EMSI_ACK sequences should be ignored.
  381.  
  382.     =====================================================================
  383.     EMSI NAK                                        **EMSI_NAK<crc16><CR>
  384.     ---------------------------------------------------------------------
  385.     EMSI NAK is transmitted by either system as a negative
  386.     acknowledgement of the valid receipt of a EMSI_DAT packet. This
  387.     should only be used as a response to EMSI_DAT and not any other
  388.     packet. Redundant EMSI_NAK packets should be ignored.
  389.  
  390.     The EMSI_DAT packet
  391.     =====================================================================
  392.     The EMSI_DAT packet is the core of an EMSI negotiated session. It
  393.     contains information vital to the mail session. The following pseudo
  394.     structure shows the layout of the EMSI_DAT packet.
  395.  
  396.     EMSI_DAT
  397.         fingerprint,            "EMSI"
  398.         system_address_list,
  399.         password,
  400.         link_codes,
  401.         compatibility_codes,
  402.         mailer_product_code,
  403.         mailer_name,
  404.         mailer_version,
  405.         mailer_serial_number:    ASCII1;
  406.         extra_field_1,
  407.             ..
  408.             ..
  409.         extra_field_n:            EMSI_addon; (optional fields)
  410.     end;
  411.  
  412.     The EMSI_addon structure is defined as follows:
  413.  
  414.     EMSI_addon
  415.         product_ID,
  416.         specific_data:            ASCII1;
  417.     end;
  418.  
  419.  
  420.     Following is an example of the actual data transmitted as an EMSI_DAT
  421.     packet:
  422.  
  423.     {EMSI}{2:270/17}{}{8N1,PUA}{ZAP,ZMO,ARC,XMA}{44}{AirMail}{0.10}
  424.     {Beta-2}{IDENT}{[Advanced Engineering S.A.R.L.][Luxembourg]
  425.     [Joaquim Homrighausen][-Unpublished-][9600][MO,XA,HST,V32B,V42B]}
  426.  
  427.     EMSI_DAT field definitions
  428.     ---------------------------------------------------------------------
  429.     
  430.     =====================================================================
  431.     Fingerprint                                                      EMSI
  432.     ---------------------------------------------------------------------
  433.     The constant "EMSI". There is no need for a revision level since this    
  434.     basic format cannot change and remain backward compatible.
  435.  
  436.     =====================================================================
  437.     System address list
  438.     ---------------------------------------------------------------------
  439.     The system address list is a list of system-specific identifiers for
  440.     the E-Mail system separated by spaces.
  441.  
  442.     For FidoNet-technology based networks, it is required that
  443.     Zone:Net/Node be presented, and .Point be omitted if zero. Zone and
  444.     Net must not be zero.
  445.  
  446.     In other networks, an address such as "jhom@csource.oz.au" should be
  447.     considered valid.
  448.  
  449.     =====================================================================
  450.     Password
  451.     ---------------------------------------------------------------------
  452.     For systems using a session level password, it would be passed in
  453.     this field. Note that the same password is used for all presented
  454.     addresses and that it must be treated case insensitive.
  455.  
  456.     =====================================================================
  457.     Link codes
  458.     ---------------------------------------------------------------------
  459.     Link codes is a string of flags that specify desired connect
  460.     conditions. These codes are separated by commas. New codes may be
  461.     added with prior approval from the author of this document.
  462.  
  463.     Calling system/answering system options:
  464.  
  465.         8N1,
  466.         7E1,
  467.         7O2,
  468.         etc.       Communication parameters.
  469.  
  470.     Calling system options:
  471.  
  472.         PUA        Pickup mail for all presented addresses.
  473.         PUP        Pickup mail for primary address only.
  474.         NPU        No mail pickup desired.
  475.  
  476.  
  477.     Answering system options:
  478.  
  479.         HAT        Hold ALL traffic.
  480.         HXT        Hold compressed mail traffic.
  481.         HRQ        Hold file requests (not processed at this time).
  482.  
  483.     =====================================================================
  484.     Compatibility codes
  485.     ---------------------------------------------------------------------
  486.     Compatibility codes is a string of flags that specifies the
  487.     capabilities and enabled features of the mailer. These codes are
  488.     separated by commas. New codes may be added with prior approval from
  489.     the author of this document.
  490.      
  491.     The calling system must list supported protocols first and descending
  492.     order of preference (the most desirable protocol should be listed
  493.     first). The answering system should only present one protocol and it
  494.     should be the first item in the compatibility_codes field.
  495.  
  496.         Protocols
  497.         -----------------------------------------------------------------
  498.         DZA*    DirectZAP (Zmodem variant).
  499.         ZAP     ZedZap (Zmodem variant).
  500.         ZMO**   Zmodem w/1,024 byte data packets.
  501.         JAN     Janus.
  502.         KER     Kermit.
  503.  
  504.         Other codes
  505.         -----------------------------------------------------------------
  506.         NCP     No compatible protocols (failure).
  507.         NRQ     No file requests accepted by this system.
  508.         ARC     ARCmail 0.60-capable, as defined by the FTSC.
  509.         XMA     Supports other forms of compressed mail.
  510.         FNC     Filename conversion. This indicates that any transmitted
  511.                 files must follow the MS-DOS restrictions of an eight
  512.                 character file name followed by a three character
  513.                 extension; eg. FILENAME.EXT
  514.  
  515.     (*) DirectZAP is a variant of ZedZap. The difference is that the
  516.     transmitter only escapes CAN (18H). It is not recommended to use the
  517.     DirectZAP protocol when two systems are connected via a packet
  518.     switching network, or via another layer sensitive to control
  519.     characters such as XON and XOFF.
  520.  
  521.     (**) The minimum protocol requirement for an EMSI implementation is
  522.     to support plain Zmodem (16- or 32-bit CRC, 1,024 byte packets) which
  523.     is represented by the ZMO flag in EMSI.
  524.  
  525.     =====================================================================
  526.     Mailer product code
  527.     ---------------------------------------------------------------------
  528.     The hexadecimal representation of the EMSC product code assigned to
  529.     the mailer. Currently, the EMSC codes are the same as the FTSC
  530.     assigned codes.
  531.  
  532.     =====================================================================
  533.     Mailer name
  534.     ---------------------------------------------------------------------
  535.     Specifies the name of the E-Mail system sending the EMSI packet.
  536.  
  537.     =====================================================================
  538.     Mailer version
  539.     ---------------------------------------------------------------------
  540.     The version number of the mailer software, ie. "1.10", "2.00".
  541.  
  542.  
  543.     =====================================================================
  544.     Mailer serial number
  545.     ---------------------------------------------------------------------
  546.     The serial number, distribution source, version information, etc.
  547.     This field is usually displayed like:
  548.  
  549.         Name<sp>Version/Serial_number
  550.  
  551.     eg.
  552.  
  553.         AirMail 0.10/Beta-2
  554.  
  555.     =====================================================================
  556.     Extra fields
  557.     ---------------------------------------------------------------------
  558.     The extra fields make the EMSI handshake protocol extremely flexible.
  559.     Any program or mailer may add fields to the end of the pre-defined
  560.     structure so that program-specific data may be passed without the
  561.     concern of interferring with other systems.
  562.  
  563.     There may be any number of extra fields added to the end of this
  564.     structure. Each EXTRA_FIELD contains two ASCII1 strings:
  565.  
  566.     PRODUCT_IDENTIFIER      A unique "tag" that defines a specific
  567.                             program (such as a mailer or a utility).
  568.  
  569.     SPECIFIC_DATA           ASCII text that is specific data to the
  570.                             program defined in PRODUCT_IDENTIFIER. With
  571.                             this structure, any program can add its own
  572.                             data to the EMSI packet without affecting
  573.                             other applications.
  574.  
  575.     It is recommended that you contact the author of this document should
  576.     you have any EXTRA_FIELDS that you may think worthwhile for other
  577.     developers to implement and support.
  578.  
  579.     Predefined extra fields
  580.     ---------------------------------------------------------------------
  581.     The following extra fields have been defined to date.
  582.  
  583.     PRODUCT_IDENTIFIER   :  IDENT
  584.  
  585.     Purpose              :  General identification of system that
  586.                             includes all information to generate a St.
  587.                             Louis-format nodelist entry.
  588.  
  589.     SPECIFIC_DATA        :  system_name,
  590.                             city,
  591.                             operator_name,
  592.                             phone_number,
  593.                             baud_rate,
  594.                             flags:            ASCII2;
  595.  
  596.  
  597.         SYSTEM_NAME         The name of the system given by the user.
  598.                             This would normally be a company name, BBS
  599.                             name or other identifying text.
  600.  
  601.         CITY                The geographical location of the system.
  602.  
  603.         OPERATOR_NAME       The name of the person primarily responsible
  604.                             for the system.
  605.  
  606.         PHONE_NUMBER        The telephone number of the system, or
  607.                             "-Unpublished-" if the telephone number is
  608.                             unpublished. This MUST be in the standard
  609.                             format COUNTRY-CITY-NUMBER. Leading zeros
  610.                             should be stripped from the city code,
  611.                             ie. Stockholm (Sweden) has a city code of 08,
  612.                             included in an EMSI packet, it would read
  613.                             46-8-<number>.
  614.  
  615.         BAUD_RATE           The maximum baud rate supported by the
  616.                             system. This is NOT necessarily the same as
  617.                             the highest DTE rate.
  618.  
  619.         FLAGS               The St. Louis (FTSC) nodelist flags
  620.                             associated with the system.
  621.  
  622.  
  623.     PART III - Interactive Electronic Mail Standard Idenfitication
  624.  
  625.     Connecting two IEMSI capable systems
  626.     =====================================================================
  627.     Two specific labels are used when discussing the IEMSI definitions.
  628.     The Client, which in this case is the Terminal software, and the
  629.     Server, which in this case is the interactive on-line software,
  630.     such as a BBS package or database system. It is assumed that the
  631.     Client and the Server have established a data link and that no
  632.     data has been transmitted by the Server.
  633.  
  634.     STEP 1, IEMSI INIT    
  635.  
  636.     There is no specific sequence of events in the IEMSI definition. The
  637.     Client must monitor incoming data and if the EMSI_IRQ sequence is
  638.     detected, it attempts to negotiate an IEMSI session with the Server.
  639.     Under no circumstances is the Client allowed to transmit an EMSI_ICI
  640.     packet prior to receiving the EMSI_IRQ sequence from the Server.
  641.     All IEMSI sequences and EMSI sequences used during an IEMSI session
  642.     are terminated by a single <CR>. There are no exceptions to this.
  643.  
  644.  
  645.     STEP 2A, Server
  646.  
  647.     +-+------------------------------------------------------------------+
  648.     :1: Tries=0, T2=60 seconds                                           :
  649.     +-+------------------------------------------------------------------+
  650.     :2: Transmit EMSI_IRQ sequence                                       :
  651.     +-+------------------------------------------------------------------+
  652.     :3: T1=20 seconds, increment Tries                                   :
  653.     : :                                                                  :
  654.     : : Tries>3?                        Discontinue IEMSI negotiation.   :
  655.     +-+------------------------------------------------------------------+
  656.     :4: Wait for EMSI_ICI packet until any of the timers have expired.   :
  657.     : :                                                                  :
  658.     : : If T2 has expired, discontinue IEMSI negotiation.                :
  659.     : +------------------------------------------------------------------+
  660.     : : If T1 has expired, go to step 2.                                 :
  661.     : +------------------------------------------------------------------+
  662.     : : If EMSI_ICI seen, go to step 5.                                  :
  663.     : +------------------------------------------------------------------+
  664.     : : Go to step 4.                                                    :
  665.     +-+------------------------------------------------------------------+
  666.     :5: Receive EMSI_ICI packet                                          :
  667.     : +------------------------------------------------------------------+
  668.     : : Packet received OK?             Transmit EMSI_ISI packet, and    :
  669.     : :                                 go to step 6.                    :
  670.     : +------------------------------------------------------------------+
  671.     : : Packet not received OK?         Transmit EMSI_NAK and go to step :
  672.     : :                                 3.                               :
  673.     +-+------------------------------------------------------------------+
  674.     :6: Tries=0                                                          :
  675.     +-+------------------------------------------------------------------+
  676.     :7: T1=20 seconds, increment Tries                                   :
  677.     : :                                                                  :
  678.     : : Tries>3?                        Discontinue IEMSI negotiation.   :
  679.     +-+------------------------------------------------------------------+
  680.     :8: Wait for EMSI_ACK/EMSI_NAK until any of the timers have expired. :
  681.     : :                                                                  :
  682.     : : If T2 has expired, discontinue IEMSI negotiation.                :
  683.     : +------------------------------------------------------------------+
  684.     : : If T1 has expired or EMSI_NAK received, transmit EMSI_ISI packet :
  685.     : : again and go to step 7.                                          :
  686.     : +------------------------------------------------------------------+
  687.     : : If EMSI_ACK received, go to step 9.                              :
  688.     : +------------------------------------------------------------------+
  689.     : : Go to step 8.                                                    :
  690.     +-+------------------------------------------------------------------+
  691.     :9: IEMSI session successfully established, exit.                    :
  692.     +-+------------------------------------------------------------------+
  693.  
  694.     The Server must monitor its incoming data channel for 'normal' data,
  695.     ie. data not transmitted as IEMSI sequences, to detect if the user is
  696.     attempting to log-in without the use of IEMSI. The only basic
  697.     restriction this imposes on the Server is that user names and/or IDs
  698.     may not start with the character '*' since all EMSI/IEMSI sequences
  699.     start with this character.
  700.  
  701.     All processing of the information in the EMSI_ICI packet must be done
  702.     after transmitting the EMSI_ISI packet and receiving two EMSI_ACK
  703.     sequences in return.
  704.  
  705.  
  706.     STEP 2B, Client
  707.  
  708.     Note that this assumes that the Client has seen the EMSI_IRQ sequence
  709.     transmitted by the Server and that the negotiation is ready to take
  710.     place.
  711.  
  712.     +-+------------------------------------------------------------------+
  713.     :1: Tries=0, T2=60 seconds                                           :
  714.     +-+------------------------------------------------------------------+
  715.     :2: Transmit EMSI_ICI packet                                         :
  716.     +-+------------------------------------------------------------------+
  717.     :3: T1=20 seconds, increment Tries                                   :
  718.     +-+------------------------------------------------------------------+
  719.     :5: Tries>3 or T2 expired?            Discontinue IEMSI negotiation. :
  720.     : +------------------------------------------------------------------+
  721.     : : If T1 has expired, go to step 2.                                 :
  722.     : +------------------------------------------------------------------+
  723.     : : If EMSI_ISI seen, go to step 6.                                  :
  724.     : +------------------------------------------------------------------+
  725.     : : Go to step 5.                                                    :
  726.     +-+------------------------------------------------------------------+
  727.     :6: Receive EMSI_ISI packet                                          :
  728.     : +------------------------------------------------------------------+
  729.     : : Packet received OK?              Transmit EMSI_ACK packet twice, :
  730.     : :                                  and go to step 7.               :
  731.     : +------------------------------------------------------------------+
  732.     : : Packet not received OK?          Transmit EMSI_NAK and go to step:
  733.     : :                                  3.                              :
  734.     +-+------------------------------------------------------------------+
  735.     :7: IEMSI session successfully established, exit.                    :
  736.     +-+------------------------------------------------------------------+
  737.  
  738.     All processing of the information in the EMSI_ISI packet must be done
  739.     after transmitting two EMSI_ACK sequences in return.
  740.  
  741.     If either of the ICI or ISI packets are NAK'd three consecutive times,
  742.     the session negotiation attempt is terminated and the Client proceeds
  743.     as it would have done should the Server not have supported IEMSI.
  744.  
  745.  
  746.     IEMSI packet and sequence definitions
  747.     =====================================================================
  748.  
  749.     =====================================================================
  750.     EMSI ACK                                        **EMSI_ACK<crc16><CR>
  751.     ---------------------------------------------------------------------
  752.     EMSI ACK is transmitted by either Client or Server as a positive
  753.     acknowledgement of the valid receipt of an IEMSI packet such as
  754.     EMSI_ISI and EMSI_ICI. During an IEMSI session, this sequence can,
  755.     however, be used as a positive acknowledgement for other IEMSI
  756.     packets. Redundant EMSI_ACK sequences should be ignored.
  757.  
  758.     =====================================================================
  759.     EMSI NAK                                        **EMSI_NAK<crc16><CR>
  760.     ---------------------------------------------------------------------
  761.     EMSI NAK is transmitted by either Client or Server as a negative
  762.     acknowledgement of the valid receipt of an IEMSI packet such as
  763.     EMSI_ISI and EMSI_ICI. During an IEMSI session, this sequence can,
  764.     however, be used as a negative acknowledgement for other IEMSI
  765.     packets. Redundant EMSI_NAK sequences should be ignored.
  766.  
  767.     =====================================================================
  768.     EMSI IRQ                                        **EMSI_IRQ<crc16><CR>
  769.     ---------------------------------------------------------------------
  770.     Similar to EMSI_REQ which is used by mailer software to negotiate a
  771.     mail session. IRQ identifies the Server as being capable of
  772.     negotiating an IEMSI session. When the Client detects an IRQ sequence
  773.     in its inbound data stream, it attempts to negotiate an IEMSI
  774.     session.
  775.  
  776.     =====================================================================
  777.     EMSI IIR                                        **EMSI_IIR<crc16><CR>
  778.     ---------------------------------------------------------------------
  779.     The IIR (Interactive Interrupt Request) sequence is used by either
  780.     Client or Server to abort the current negotiation. This could be
  781.     during the initial IEMSI handshake or during other interactions
  782.     between the Client and the Server.
  783.  
  784.     =====================================================================
  785.     EMSI ICI                             **EMSI_ICI<len><data><crc32><CR>
  786.     ---------------------------------------------------------------------
  787.     The ICI packet is used by the Client to transmit its configuration
  788.     and Server-related information to the Server. It contains Server
  789.     parameters, Client options, and Client capabilities.
  790.  
  791.     =====================================================================
  792.     EMSI ISI                             **EMSI_ISI<len><data><crc32><CR>
  793.     ---------------------------------------------------------------------
  794.     The ISI packet is used by the Server to transmit its configuration
  795.     and Client-related information to the Client. It contains Server data
  796.     and capabilities.
  797.  
  798.  
  799.     =====================================================================
  800.     EMSI ISM                             **EMSI_ISM<len><data><crc32><CR>
  801.     ---------------------------------------------------------------------
  802.     The ISM packet is used to transfer ASCII images from the Server to
  803.     the Client. These images can then be recalled by the Client when
  804.     the Server needs to display a previously displayed image. This will
  805.     be further described in future revisions of this document.
  806.  
  807.     =====================================================================
  808.     EMSI CHT                                        **EMSI_CHT<crc16><CR>
  809.     ---------------------------------------------------------------------
  810.     The CHT sequence is used by the Server to instruct the Client
  811.     software to enter its full-screen conversation mode function (CHAT).
  812.     Whether or not the Client software supports this is indicated in the
  813.     ICI packet.
  814.  
  815.     If the Server transmits this sequence to the Client, it must wait for
  816.     an EMSI_ACK prior to engaging its conversation mode. If no EMSI_ACK
  817.     sequence is received with ten seconds, it is safe to assume that the
  818.     Client does not support EMSI_CHT. If, however, an EMSI_NAK sequence
  819.     is received from the Client, the Server must re-transmit the
  820.     EMSI_CHT sequence. Once the on-line conversation function has been
  821.     sucessfully activated, the Server must not echo any received
  822.     characters back to the Client.
  823.  
  824.     =====================================================================
  825.     EMSI TCH                                        **EMSI_TCH<crc16><CR>
  826.     ---------------------------------------------------------------------
  827.     The TCH sequence is used by the Server to instruct the Client
  828.     software to terminate its full-screen conversation mode function
  829.     (CHAT).
  830.  
  831.     If the Server transmits this sequence to the Client, it must wait for
  832.     an EMSI_ACK prior to leaving its conversation mode. If no EMSI_ACK
  833.     sequence is received with ten seconds, a second EMSI_TCH sequence
  834.     should be issued before the Server resumes operation. If, however, an
  835.     EMSI_NAK sequence is received from the Client, the Server must
  836.     re-transmit the EMSI_TCH sequence.
  837.  
  838.  
  839.     The EMSI_ICI packet
  840.     =====================================================================
  841.     The following pseudo structure shows the layout of the EMSI_ICI
  842.     packet. Note that the information in the EMSI_ICI packet may not
  843.     exceed 2,048 bytes.
  844.  
  845.     EMSI_ICI
  846.         name,
  847.         alias,
  848.         location,
  849.         data#,
  850.         voice#,
  851.         password,
  852.         birthdate,
  853.         crtdef,
  854.         protocols,
  855.         capabilities,
  856.         requests,
  857.         software,
  858.         xlattabl:                ASCII1;
  859.     end;
  860.  
  861.     EMSI_ICI field definitions
  862.     ---------------------------------------------------------------------
  863.     
  864.     =====================================================================
  865.     Name and Alias (or Handle)
  866.     ---------------------------------------------------------------------
  867.     The name and possible alias (AKA) of the user (Client). This must be
  868.     treated case insensitively by the Server.
  869.  
  870.     =====================================================================
  871.     Location
  872.     ---------------------------------------------------------------------
  873.     The geographical location of the user, ie. Stockholm, Sweden.
  874.  
  875.     =====================================================================
  876.     data# and voice#
  877.     ---------------------------------------------------------------------
  878.     Unformatted data and voice telephone numbers of the user. Unformatted
  879.     is defined as the full telephone number, including country and local
  880.     area code. Eg. 46-8-90510 is a telephone number in Stockholm, Sweden.
  881.  
  882.     =====================================================================
  883.     Password
  884.     ---------------------------------------------------------------------
  885.     The password for the user. This must be treated case insensitively by
  886.     the Server.
  887.  
  888.  
  889.     =====================================================================
  890.     Birthdate
  891.     ---------------------------------------------------------------------
  892.     Hexadecimal string representing a long integer containing the birth-
  893.     date of the user in UNIX notation (number of seconds since midnight,
  894.     Jan 1 1970). This must be treated case insensitively by the Server.
  895.  
  896.     =====================================================================
  897.     CrtDef
  898.     ---------------------------------------------------------------------
  899.     Consisting of four sub-fields separated by commas, this field
  900.     contains from left to right: The requested terminal emulation
  901.     protocol, the number of rows of the user's CRT, the number of columns
  902.     of the user's CRT, and the number of ASCII NUL (00H) characters the
  903.     user's software requires to be transmitted between each line of text.
  904.  
  905.     The following terminal emulation protocols are defined:
  906.  
  907.         AVT0    AVATAR/0+. Used in conjunction with ANSI. If AVT0 is
  908.                 specified by the Client, support for ANSI X3.64 emulation
  909.                 should be assumed to be present.
  910.         ANSI    ANSI X3.64
  911.         VT52    DEC VT52
  912.         VT100   DEC VT100
  913.         TTY     No terminal emulation, also referred to as RAW mode.
  914.  
  915.     =====================================================================
  916.     Protocols
  917.     ---------------------------------------------------------------------
  918.     The file transfer protocol option specifies the preferred method of
  919.     transferring files between the Client and the Server in either
  920.     direction. The Client presents all transfer protocols it is capable
  921.     of supporting and the Server chooses the most appropriate protocol.
  922.  
  923.         DZA*    DirectZAP (Zmodem variant)
  924.         ZAP     ZedZap (Zmodem variant)
  925.         ZMO     Zmodem w/1,024 byte data packets
  926.         SLK     SEAlink
  927.         KER     Kermit
  928.     
  929.     (*) DirectZAP is a variant of ZedZap. The difference is that the
  930.     transmitter only escapes CAN (18H). It is not recommended to use the
  931.     DirectZAP protocol when the Client and the Server are connected via a
  932.     packet switching network, or via another layer sensitive to control
  933.     characters such as XON and XOFF.
  934.  
  935.  
  936.     =====================================================================
  937.     Capabilities
  938.     ---------------------------------------------------------------------
  939.     The capabilities of the user's software. If more than one capability
  940.     is listed, each capability is separated by a comma.
  941.  
  942.     The following capability codes are defined:
  943.  
  944.         CHT     Can do full-screen on-line conversation (CHAT).
  945.         MNU     Can do ASCII image download (see ISM packet).
  946.         TAB     Can handle TAB (ASCII 09H) characters.
  947.         ASCII8  Can handle 8-bit IBM PC ASCII characters.
  948.  
  949.     =====================================================================
  950.     Requests
  951.     ---------------------------------------------------------------------
  952.     The requests field specifies what the user wishes to do once the
  953.     initial IEMSI negotiation has been successfully completed. If more
  954.     than one capability is listed, each capability is separated by a
  955.     comma.
  956.  
  957.     The following request codes are defined:
  958.  
  959.         NEWS    Show bulletins, announcements, etc.
  960.         MAIL    Check for new mail.
  961.         FILE    Check for new files.
  962.         HOT     Hot-Keys.
  963.         CLR     Screen clearing.
  964.         HUSH    Do not disturb.
  965.         MORE    Page pausing, often referred to as "More".
  966.         FSED*   Full-screen editor.
  967.         XPRS    <reserved>.
  968.  
  969.     (*) Note that this allows the Client to request use of a full-screen
  970.     editor without requiring that it also supports a full-screen terminal
  971.     emulation protocol.
  972.  
  973.     =====================================================================
  974.     Software
  975.     ---------------------------------------------------------------------
  976.     The name, version number, and optionally the serial number of the
  977.     user's software. Eg. {FrontDoor,2.00,AE000001}.
  978.  
  979.     =====================================================================
  980.     XlatTabl
  981.     ---------------------------------------------------------------------
  982.     Used for character translation between the Server and the Client.
  983.     This field has not been completely defined yet and should always be
  984.     transmitted as {} (empty).
  985.  
  986.  
  987.     The EMSI_ISI packet
  988.     =====================================================================
  989.     The following pseudo structure shows the layout of the EMSI_ISI
  990.     packet. Note that the information in the EMSI_ISI packet may not
  991.     exceed 2,048 bytes.
  992.  
  993.     EMSI_ISI
  994.         id,
  995.         name,
  996.         location,
  997.         operator,
  998.         localtime,
  999.         notice,
  1000.         wait,
  1001.         capabilities:            ASCII1;
  1002.     end;
  1003.  
  1004.     EMSI_ISI field definitions
  1005.     ---------------------------------------------------------------------
  1006.     
  1007.     =====================================================================
  1008.     ID
  1009.     ---------------------------------------------------------------------
  1010.     The name, version number, and optionally the serial number of the
  1011.     Server software. Eg. {RemoteAccess,1.10/b5,CS000001}.
  1012.  
  1013.     =====================================================================
  1014.     Name
  1015.     ---------------------------------------------------------------------
  1016.     The name of the Server system. Eg. {Advanced Engineering S.A.R.L.}.
  1017.  
  1018.     =====================================================================
  1019.     Location
  1020.     ---------------------------------------------------------------------
  1021.     The geographical location of the user, ie. Stockholm, Sweden.
  1022.  
  1023.     =====================================================================
  1024.     Operator
  1025.     ---------------------------------------------------------------------
  1026.     The name of the primary operator of the Server software. Eg. {Joaquim
  1027.     H. Homrighausen}.
  1028.  
  1029.  
  1030.  
  1031.     =====================================================================
  1032.     Localtime
  1033.     ---------------------------------------------------------------------
  1034.     Hexadecimal string representing a long integer containing the current
  1035.     time of the Server in UNIX notation (number of seconds since midnight,
  1036.     Jan 1 1970). This must be treated case insensitively by the Client.
  1037.  
  1038.     =====================================================================
  1039.     Notice
  1040.     ---------------------------------------------------------------------
  1041.     May contain copyright notices, system information, etc. This field
  1042.     may optionally be displayed by the Client.
  1043.  
  1044.     =====================================================================
  1045.     Wait
  1046.     ---------------------------------------------------------------------
  1047.     A single character used by the Server to indicate that the user
  1048.     has to press the <Enter> key to resume operation. This is used in
  1049.     conjunction with ASCII Image Downloads (see ISM packet).
  1050.  
  1051.     =====================================================================
  1052.     Capabilities
  1053.     ---------------------------------------------------------------------
  1054.     The capabilities of the Server software. No Server software
  1055.     capabilities have currently been defined.
  1056.  
  1057.     Credits and other notes
  1058.     =====================================================================
  1059.     The original EMSI specifications were designed by Chris Irwin and
  1060.     Joaquim H. Homrighausen. The original IEMSI specifications were
  1061.     designed by Joaquim H. Homrighausen and Andrew Milner.
  1062.  
  1063.     --- end of "emsi.doc" ---
  1064.  
  1065.